-
-
Notifications
You must be signed in to change notification settings - Fork 79
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. Weβll occasionally send you account related emails.
Already on GitHub? Sign in to your account
ci: add typos as spell checker #641
base: develop
Are you sure you want to change the base?
Conversation
β Deploy Preview for livecodes ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
Quality Gate passedIssues Measures |
Thanks @zyf722 That is nice. Is there an easy way to run the test locally? e.g. npm package. This can allow us to reproduce problems locally without having to keep pushing to GitHub to see results. How about cspell? Also has a vscode extension which seems to be very popular. I'm actually using it. |
You might also be interested in their pre-commit hook.
It's new to me. I will check it out and see if it fits our needs better :)
Indeed, actually I guess we might be faced with false positives in some cases. Perhaps it would be better to only throw warning annotations when typos are detected, rather than error annotations and terminate the workflow? |
Actually, cspell does have some false positives in my experience with it.
I agree. |
Quality Gate passedIssues Measures |
What type of PR is this? (check all applicable)
Description
This PR adds crate-io/typos as spell checker in CI process.
Spell errors will cause the CI to fail, with errors reported in the Annotations part of GitHub Actions workflow runs (link to this run):
Its behavior can be controlled with the
typos.toml
file, with config specifications detailed here.Added tests?
Added to documentations?